home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 27.zip / BS1 part 27 / TapeWControleV1.0.adf / tapeworm.doc < prev    next >
Text File  |  1993-09-03  |  16KB  |  402 lines
  1.                                 SKID ROW
  2.  
  3.                                 presents
  4.  
  5.                               TAPE WORM-FS
  6.                               USER'S GUIDE
  7.  
  8. INTRODUCTION
  9.  
  10. Congratulations on your purchase of TapeWorm-FS for your Amiga computer!
  11. TapeWorm-FS is fully-functional filesystem for SCSI tape drives.  By
  12. using TapeWorm-FS you may access your tape drive just as you would any
  13. other AmigaDOS volume.  That means that you can get directories, add and
  14. delete files, copy files, and perform all file management operations
  15. as if you were using a floppy or hard disk drive.  Note: Since through
  16. TapeWorm-FS your tape drive functions as a Write Once Read Many (WORM)
  17. drive, all data copied to the drive remains on the tape even if you
  18. delete files.  See the section on Using TapeWorm-FS for more information.
  19.  
  20. System Requirements
  21.  
  22. TapeWorm-FS will work on any Amiga computer (or Video Toaster Workstation)
  23. operating under Workbench 2.x or above with a SCSI tape drive (DAT,
  24. 8mm, or QIC format).  There are no minimum memory requirements.  Drives
  25. that support the SCSI II fast search mode are recommended for superior
  26. performance.
  27.  
  28. Installation
  29.  
  30. The TapeWorm-FS disk is not copy protected in any way so you may
  31. make one archival copy in order to protect your investment.  To install
  32. Tape-Worm-FS onto your hard drive, follow these steps:
  33.  
  34. Step 1: Immediately make a backup copy of your TapeWorm-FS original disk, 
  35.         and store it in a safe place.
  36. Step 2: Insert the copy of the TapeWorm-FS disk into a floppy drive, and 
  37.         open the disk by double-clicking on its icon from Workbench.
  38. Step 3: Once the disk contents are displayed on your screen, you will see
  39.         an icon named "Install TapeWorm-FS".  This is the installation
  40.         program that will place the TapeWorm-FS files into the proper
  41.         locations.  Double click on this icon to execute the installation
  42.         program.
  43. Step 4: The TapeWorm-FS Installation Program window will appear on your
  44.         screen.  You must Set Installation Mode by selecting the 
  45.         Intermediate User or Expert User gadget.  The Expert User mode
  46.         will allow you to control the installation process at every step,
  47.         letting you decide exactly where you wish each file to be 
  48.         installed.  Click on the Proceed With Install gadget to continue
  49.         or the Abort Install gadget to end the process.
  50.  
  51. TapeWorm-FS is now installed on your system.  You must now set your 
  52. system-configuration.  See the section on Configuring TapeWorm-FS.
  53.  
  54. If you do not wish to use the installation program to install TapeWorm-FS,
  55. you may perform a manual installation by following these steps:
  56.  
  57. Step 1a: If your system is operation under AmigaDOS 2.1 or later, copy the
  58.          file 'Tape' from the TapeWorm-FS disk to your system's 
  59.          'Devs:DosDrivers' directory.
  60. Step 1b: If your system is operating under AmigaDOS 2.0, append the
  61.          contents of 'TW.Mountlist' file to your system's 'Devs:MountList'
  62.          file and add the command 'Mount TAPE:' to your system's 
  63.          'S:User-Startup' file.
  64. Step 2:  Copy the file 'TapeWorm-FS' to your system's 'L:' directory.
  65.  
  66. If a previous version of TapeWorm-FS is already installed on your system,
  67. and you wish to update the version you are using, perform these steps:
  68.  
  69. Step 1: Copy the file 'TapeWorm-FS' from the disk to your system's 'L:'
  70.         directory.
  71. Step 2: Copy the TWConfig and TWCtrl files to the directory of your 
  72.         choice.
  73.  
  74. TapeWorm-FS is now installed on your system.  Now you must configure your
  75. drive for operation on your system and set the TapeWorm-FS options.
  76.  
  77. The TapeWorm-FS Utilities
  78. -------------------------
  79.  
  80. TW Config
  81.  
  82. Before you can use TapeWorm-FS, you must properly configure the TW.config
  83. file to reflect your system configuration.  You may do so by using the
  84. TWConfig utility which was placed in the location on your hard drive
  85. that you specified during the installation procedure.
  86.  
  87. Start the TWConfig program from Workbench or CLI, and the TWConfig screen
  88. will appear.  From this screen you will be able to:
  89.  
  90.    Configure Drive
  91.    Set Options
  92.    Format
  93.    Recover
  94.  
  95. Configure Drive
  96.  
  97. Click on the Configure Drive gadget to configure your drive for use
  98. under TapeWorm-FS.
  99.  
  100. Device
  101.  
  102. Under the Device requester, you will be able to select the device driver
  103. for your SCSI controller.  (For example, if your computer is the Amiga
  104. 3000, you would select "scsi.device" for Commodore's SCSI controller.)
  105.  
  106. Unit
  107.  
  108. You must select the Unit number for the SCSI tape device you wish to
  109. use under TapeWorm-FS.
  110.  
  111. Blocksize
  112.  
  113. Specify the block size for your tape drive by clicking on this cycle
  114. gadget.  It is recommended that you leave the blocksize at 512 bytes
  115. for all drives except Exabyte 8mm drives, which should have a blocksize
  116. of 1024 bytes.
  117.  
  118. TapeSize
  119.  
  120. Enter the approximate size of the tape being used in this gadget (this
  121. allows the TapeWorm-FS to calculate percentage of tape full when
  122. displaying information about the tape device).
  123.  
  124. When you have configured the drive, click on Save gadget.  Click on the
  125. Cancel gadget of you do not wish to save the current configuration.
  126.  
  127. Note that most of these options only take effect when TapeWorm-FS is
  128. started.  You must reboot or kill (see the TWControl section) and restart
  129. the filesystem for the changes to take effect.
  130.  
  131. Set Options
  132.  
  133. There are several options you may select for the operation of TapeWorm-FS.
  134. Click on the Set Options gadget on the TWConfig main screen.
  135.  
  136. Buffer Reads
  137.  
  138. Files are copied to your Buffer Path (see the next page for an explanation
  139. of the Buffer Path) when they are opened.  The system then reads from 
  140. the files that are in your Buffer Path.  This feature is only really
  141. useful if the program you are using repeatedly seeks throughout the file.
  142. For example, most 'LHARC' programs seek back and forth when extracting
  143. files.
  144.  
  145. Buffer Writes
  146.  
  147. Files are written to your Buffer Path and copied to tape when the file
  148. is closed.  This is necessary for programs that seek around in a file
  149. as they are writing.  Most programs that write IFF files seek back to the
  150. beginning of the file after they are done writing, so this option is very
  151. useful.  Also, this option allows multiple files to be written to the
  152. tape simultaneously, which is not normally possible, due to the inherent
  153. limitations of tape drives.
  154.  
  155. Keep Directory on Tape
  156.  
  157. If your tape drive supports partitioning, selecting this option will let
  158. TapeWorm-FS keep the directory of the tape on the tape itself.  The
  159. directory will be kept in your directory path only when the tape is in
  160. the drive.  When you have selected this option, you must use the TWControl
  161. program to eject the tape, since TapeWorm-FS needs to update the directory
  162. on the tape to reflect the temporary directory that is on the hard disk.
  163. TapeWorm-FS will lock the tape in the drive (on drives that support this
  164. feature) so that the tape may not be ejected manually.  If your system
  165. crashes or otherwise fails before the temporary directory is written
  166. to the tape, the temporary directory will be updated the next time you
  167. insert the tape.  Unlike the other available options, this option takes
  168. effect when you format a tape and remains in effect for that tape.
  169.  
  170. Existing Files Are Read Only
  171.  
  172. This is the normal mode of operation for TapeWorm-FS.  Files can be read
  173. or overwritten, but they cannot be opened and subsequently written to.
  174. If both the Buffer Reads and Buffer Writes are enabled, you can turn
  175. off this option so that files may be updated in place.
  176.  
  177. Keep '.info' Files With Directory
  178.  
  179. By default, '.info' files are kept on tape just as other files.
  180. However, this results in slow Workbench performance as it must seek
  181. around the tape to load files.  Selecting this option directs 
  182. TapeWorm-FS to keep '.info' files as part of the directory file.
  183.  
  184. Directory Path
  185.  
  186. This is where you specify the location in which you wish TapeWorm-FS
  187. to store the device directories.  The default path is your system's
  188. 'S:' directory.
  189.  
  190. Buffer Path
  191.  
  192. If you have selected Buffer Reads or Buffer Writes, this is the location
  193. in which TapeWorm-FS will maintain the buffer.  The default path is in
  194. your system's RAM device.  The buffer is used to store files for reading
  195. and writing (when Buffer Reads or Buffer Writes is selected) so that
  196. these operations will be performed more quickly than if the reads and
  197. writes were from the tape directly.
  198.  
  199. When you have set the options you desire, click on the Save gadget.
  200. Click on the Cancel gadget if you do not wish to save the current
  201. configuration.
  202.  
  203. Format
  204.  
  205. Before accessing your tape drive through TapeWorm-FS, you must insert
  206. a tape into your drive and format the tape.  Insert the tape you wish
  207. to format into the tape drive.  To format the tape, click on the Format
  208. gadget on the TWConfig main screen.  A requester will appear that asks
  209. you to Enter volume name you wish to give to the tape.  Type the name
  210. into this requester and click on the Continue gadget.  TapeWorm-FS will
  211. now format your tape.  If you wish to exit without formatting a tape,
  212. click on the Abort gadget.
  213.  
  214. WARNING: You must only format the tape before using it for the first
  215. time.  If you format the tape again, any data that may have been
  216. previously written to the tape will be lost.
  217.  
  218. Recover
  219.  
  220. Should your tape directory become unavailable to you.  TapeWorm-FS
  221. allows you to rebuild a directory file from the information on a tape.
  222. Insert the tape for which you wish to have a directory rebuilt, then
  223. click on this gadget on the TWConfig main screen.
  224.  
  225. TWCtrol
  226.  
  227. The TWCtrl utility has the following four options (they can also be
  228. invoked from the CLI using the template "TWCtrl <command>):
  229.  
  230.    Inhibit
  231.    Un-Inhibit
  232.    Kill
  233.    Eject
  234.  
  235. Inhibit
  236.  
  237. Selecting this option prevents the filesystem from accessing the tape
  238. drive.  This allows you to make use of other programs that access the
  239. tape drive, such as backup utilities (i.e., Ami-Back).
  240.  
  241. Un-Inhibit
  242.  
  243. Selecting this option allows the filesystem to access the tape drive
  244. after it has been inhibited.
  245.  
  246. Kill
  247.  
  248. This option causes the filesystem to exit.  This is useful if you want
  249. the filesystem to be restarted in order to load a new configuration
  250. or if you are done using the current configuration.  This will only
  251. take affect if there are no outstanding locks on the filesystem
  252. (e.g., there are no assigns to the filesystem, you aren't CD'd to it,
  253. and there is no volume in the drive).
  254.  
  255. Eject
  256.  
  257. The option causes the tape in the drive to be ejected (on drives that
  258. support eject).  If the tape was formatted with the "Keep Directory
  259. on Tape" option, the directory on the tape will be updated.
  260.  
  261. Using TapeWorm-FS
  262.  
  263. TapeWorm-FS allows you to access files on your tape device in the same
  264. way as you would any other AmigaDOS device.  The commands such as
  265. dir, copy, list, delete, etc. work transparently on a device accessed 
  266. through TapeWorm-FS.  However, since data cannot actually be deleted
  267. from within a tape (data can only be appended to a tape without writing
  268. over the existing data), TapeWorm-FS causes your tape device to 
  269. function as a Write Once Read Many (WORM) drive.  This means that every
  270. file ever written to the device remains on the device, even if you delete
  271. the file.
  272.  
  273. When you use the delete command on a file that is located on a TapeWorm-
  274. FS device, the directory file that is maintained for the device is
  275. updated so that the filename will no longer appear by using the
  276. standard AmigaDOS and Workbench commands.  However, you can still access
  277. overwritten or deleted files from the CLI by using the special 
  278. character "@" with a directory or filename.
  279.  
  280. Type "file@<number>" to obtain the version <number> of file.  Versions
  281. start at 1 and go up.  The latest version of a file does not have a 
  282. version number.
  283.  
  284. Type "dir@" in order to have deleted or overwritten files show up in
  285. the directory listing using the "file@<number>" notation.
  286.  
  287. Type "dir@<date>" in order to display only files less than or equal
  288. to <date> in the directory listing.  This also uses the 
  289. "file@<number>" notation.
  290.  
  291. Theory of Operation
  292.  
  293. TapeWorm-FS is an AmigaDOS filesystem handler.  A handler acts as an
  294. interface which allows AmigaDOS to access a piece of hardware.  For
  295. example, 'SER:' allows access to the Amiga's serial port.  A filesystem
  296. handler not only allows access to a storage device, but it maintains
  297. information on the device about files and directories as well.
  298.  
  299. Unlike a hard drive, a streaming tape drive does not allow any arbitrary
  300. block on the tape to be read or written.  Data can only be written by
  301. being appended to the end of the tape.  Also, the tape must be positioned
  302. to read an arbitrary block.  Positioning the tape requires much more
  303. than the corresponding hard disk operation.
  304.  
  305. Due to these limitations, TapeWorm-FS does not keep directory and file
  306. information on the tape itself as FastFileSystem or other hard disk
  307. filesystems would.  TapeWorm-FS maintains the directory information
  308. in a file on your hard disk, and it uses the tape only for storing
  309. the actual file data (as well as recovery information).
  310.  
  311. Performance
  312.  
  313. Once your directory files become large you will notice a slow-down
  314. when performing directory operations.  This is due to the way AmigaDOS
  315. performs seeks within large files.  We recommend adding buffers (using
  316. the AmigaDOS command AddBuffers) to the drive on which your "Directory
  317. Path" is located.  As a rule of thumb, add one buffer for every 36k in
  318. size of the largest directory file.
  319.  
  320. The Buffer Reads and Buffer Writes options can greatly increase 
  321. performance for programs that seek around in a file, or perform lots
  322. of little reads and writes.  A RAM directory is the best place to set
  323. your Buffer Path except when you have files that are larger than the
  324. amount of free RAM available on your system.
  325.  
  326. Note: The most efficient way to use a tape drive is to read files off
  327. in the same order they were put on.  This eliminates seek time, since
  328. after reading a file the tape is immediately positioned to read the
  329. next file.
  330.  
  331. Appendix I:
  332.  
  333. TW.Config File Format
  334.  
  335. DEVICE = <scsi device name>
  336. UNIT = <scsi unit number>
  337. BLOCKSIZE = <block size in bytes>
  338. TAPESIZE = <size of tape in blocks (=MB*2048 for 512 byte blocks)>
  339. DIRPATH = <path to keep directory files (with trailing '/')>
  340. FASTLOCATE = <TRUE or FALSE, to (use/not use) SCSI2 fast locate command>
  341. DEBUG = <optional debug file name and path>
  342. BUFFPATH = <path to keep temporary files (with trailing '/')>
  343. BUFFERREADS = <TRUE or FALSE, Copy file to BuffPath on open>
  344. BUFFERWRITES = <TRUE or FALSE, Write file to BuffPath, copy on close>
  345. DRIVE = <the manufacture and model of the drive this setup is for>
  346. SUPP_PARTITION = <TRUE or FALSE, Does this drive support partitioning?>
  347. MAXBLOCKSIZE = <Maximum blocksize of this drive>
  348. PARTITION = <TRUE or FALSE, Keep directories on tape>
  349. READONLY = <TRUE or FALSE, Existing files are read only>
  350. INFOWITHDIR = <TRUE or FALSE, ".info" files are kept in directory>
  351. USE24BITDMA =<TRUE or FALSE, Use 24 bit DMA-able memory for buffers>
  352.  
  353. The following is an example TW.Config file:
  354.  
  355. DEVICE = scsi.device
  356. UNIT = 4
  357. BLOCKSIZE = 512
  358. TAPESIZE = 1300
  359. DIRPATH = SYS:S/
  360. FASTLOCATE = TRUE
  361. DEBUG = SYS:debug/
  362. BUFFPATH = RAM:
  363. BUFFERREADS = TRUE
  364. BUFFERWRITES = TRUE
  365. DRIVE = ARCHIVE Python
  366. SUPP_PARTITION = TRUE
  367. MAXBLOCKSIZE = 16777215
  368. PARTITION = TRUE
  369. READONLY = FALSE
  370. INFOWITHDIR = TRUE
  371. USE24BITDMA = FALSE
  372.  
  373. Appendix II:
  374.  
  375. Compatible Tape Drives
  376.  
  377. The following is a partial list of the drives which are compatible
  378. with TapeWorm-FS.
  379.  
  380. Archive Python DAT drive
  381. Archive Sidewinder 250
  382. Archive Viper 2525s
  383. Commodore 3070
  384. Exabyte 8mm
  385. Hewlet Packard DAT drive
  386. Sony DAT drive
  387. Tandberg 3640
  388. Teac MT-2ST
  389. Wangtek 5125
  390. Wangtek 5150es
  391. Wangtek 5525es
  392. Wangtek 6200 DAT
  393. Wangtek SCSI-36
  394. Xybyte 8mm (2.3 gigabytes)
  395.  
  396. If you are able to use TapeWorm-FS successfully with a tape drive not
  397. listed about, please contact us so that we may include the drive name
  398. in the next manual revision.
  399.  
  400. SKID ROW  SKID ROW  SKID ROW  SKID ROW  SKID ROW  SKID ROW  SKID ROW
  401.  
  402.